Docs: Add job dispatch and resource tiers documentation#271
Open
erick-GeGe wants to merge 3 commits intomainfrom
Open
Docs: Add job dispatch and resource tiers documentation#271erick-GeGe wants to merge 3 commits intomainfrom
erick-GeGe wants to merge 3 commits intomainfrom
Conversation
joaquingx
requested changes
Mar 27, 2026
Contributor
joaquingx
left a comment
joaquingx
left a comment
There was a problem hiding this comment.
Good coverage of the dispatch system, but I think this reads more like internal code notes than documentation. A few suggestions:
Too much implementation detail
- Things like the Redis lock command (
SET spider_jobs_lock 1 NX EX 120), internal function names (_get_cluster_resources(),_dispatch_single_job()), and the "Key Files" table are implementation details that will go stale as code changes. These belong in code comments or docstrings, not in docs.
Suggestion: Simplify to focus on what users need to know (tiers, statuses, config options) and drop the code-level details. The code should document itself.
joaquingx
approved these changes
Apr 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please include a summary of the changes, relevant motivation and context.
Issue
Checklist before requesting a review